Skip to content

docs: document Jira + GitHub PR linking integration#88

Merged
tarun-etikala merged 3 commits into
red-hat-data-services:mainfrom
tarun-etikala:docs/jira-github-integration
May 4, 2026
Merged

docs: document Jira + GitHub PR linking integration#88
tarun-etikala merged 3 commits into
red-hat-data-services:mainfrom
tarun-etikala:docs/jira-github-integration

Conversation

@tarun-etikala
Copy link
Copy Markdown
Contributor

@tarun-etikala tarun-etikala commented May 4, 2026 •
edited
Loading

Description

Adds documentation for the Jira + GitHub integration that shows linked PRs on Jira issues. Updates CONTRIBUTING.md with a new "Linking PRs to Jira" section and clarifies the Jira Ticket field in the PR template.

Jira Ticket

RHAIENG-4115

Testing

  • No testing required (documentation/config change only)

Checklist

  • I have read CONTRIBUTING.md
  • No .env or secret files are included in this PR
  • All changes are within scope of the linked Jira ticket (if not, explain in Description)

Review Guidance

Documentation-only change — two files affected:

  • CONTRIBUTING.md — new "Linking PRs to Jira" section after "Commit message conventions"
  • .github/PULL_REQUEST_TEMPLATE.md — expanded comment on the Jira Ticket field

Related PRs

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 74676832-b4f8-48ff-807b-9d8dd1bc5a25

📥 Commits

Reviewing files that changed from the base of the PR and between e6e2cc4 and 5ea9586.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
✅ Files skipped from review due to trivial changes (1)
  • CONTRIBUTING.md
📝 Walkthrough

Walkthrough

Updated repository documentation to make Jira ticket linkage explicit: the PR template now requires a Jira ticket ID, and CONTRIBUTING.md adds a “Linking PRs to Jira” section and wraps example blocks in fenced code blocks.

Changes

Jira Linking Documentation

Layer / File(s) Summary
PR Template edit
.github/PULL_REQUEST_TEMPLATE.md		 Replaced the generic "Jira Ticket" placeholder with an explicit instruction to include the Jira ticket ID (e.g., RHAIENG-123) in the template field.
Formatting examples
CONTRIBUTING.md		 Wrapped the "Format" and "Breaking changes" examples in fenced ```text code blocks for clearer formatting.
Linking guidance
CONTRIBUTING.md		 Added a "Linking PRs to Jira" section documenting that including a Jira ticket ID in the PR title, branch name, commit message, or PR description will surface the PR under Development on the corresponding Jira issue.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation for Jira + GitHub PR linking integration.
Description check ✅ Passed The description is well-related to the changeset, providing clear details about the documentation updates to CONTRIBUTING.md and the PR template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Timed out fetching pipeline failures after 30000ms

Review rate limit: 9/10 reviews remaining, refill in 6 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

@tarun-etikala @claude
docs: document Jira + GitHub PR linking integration
0b1b206 
Add guidance on how Jira ticket IDs in PR titles, branch names, or the
PR template field auto-link pull requests to Jira issues.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@tarun-etikala tarun-etikala force-pushed the docs/jira-github-integration branch from 5bbbea2 to 0b1b206 Compare May 4, 2026 15:05
@tarun-etikala @claude
docs: add language tags to fenced code blocks in CONTRIBUTING.md
e6e2cc4 
Fixes markdownlint MD040 violations on two code blocks missing language
identifiers (commit message format template and breaking change example).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
mpk-droid
mpk-droid reviewed May 4, 2026
View reviewed changes
Comment thread CONTRIBUTING.md Outdated

## Linking PRs to Jira

This repository has GitHub + Jira integration enabled. When you include a Jira ticket ID (e.g. `RHAIENG-123`) in your PR title, branch name, or the **Jira Ticket** field in the PR template, the pull request automatically appears under **Development** on the Jira issue. This gives the visibility into which tickets have active or merged code without leaving Jira.
Copy link
Copy Markdown
Contributor

@mpk-droid mpk-droid May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: The Jira ticket (RHAIENG-4115) lists commit messages as another place where the integration matches issue keys. Consider adding "commit messages" to the list here. Also, "the Jira Ticket field in the PR template" is slightly imprecise — the integration scans the visible PR description body, not the HTML comment placeholder. Saying "PR description" would be more accurate.

Assisted by Claude Opus 4.6 (1M context)

Copy link
Copy Markdown
Contributor Author

@tarun-etikala tarun-etikala May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed

mpk-droid
mpk-droid reviewed May 4, 2026
View reviewed changes
Comment thread CONTRIBUTING.md Outdated

## Linking PRs to Jira

This repository has GitHub + Jira integration enabled. When you include a Jira ticket ID (e.g. `RHAIENG-123`) in your PR title, branch name, or the **Jira Ticket** field in the PR template, the pull request automatically appears under **Development** on the Jira issue. This gives the visibility into which tickets have active or merged code without leaving Jira.
Copy link
Copy Markdown
Contributor

@mpk-droid mpk-droid May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "This gives the visibility" → "This gives visibility" (drop "the").

Assisted by Claude Opus 4.6 (1M context)

Copy link
Copy Markdown
Contributor Author

@tarun-etikala tarun-etikala May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed

mpk-droid
mpk-droid approved these changes May 4, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@mpk-droid mpk-droid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Added non-blocking/minor comments

@tarun-etikala @claude
docs: address PR review feedback on Jira linking section
5ea9586 
Add commit messages to the list of places Jira scans, use "PR
description" instead of "Jira Ticket field in the PR template",
and fix grammar ("the visibility" → "visibility").

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@tarun-etikala tarun-etikala merged commit e7c4fc6 into red-hat-data-services:main May 4, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mpk-droid mpk-droid mpk-droid approved these changes

Assignees

No one assigned

Labels

area/ci area/docs size/xs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tarun-etikala @mpk-droid